6.2 编辑外部用户群组

基本信息

Path: /api/v1/externalUserBand/update

Method: POST

接口描述:

  1. 编辑外部用户群组

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 必须  

Body

  1. 部分参数,如关联对象ID,需要通过在控制台手动获取,以Chrome浏览器为例,获取方式为F12打开“开发者工具”,在Network中找到对应对象的查询接口手动获取该对象的ID
  2. 用户目录ID,userDirectoryId获取方式,用“开发者工具”过滤请求 userDirectory/queryAll,打开控制台“业务管理”->“用户管理”页面,查看响应体数据获取对应用户目录的ID,也可以通过用户目录查询接口获取ID

根据群组ID、用户目录ID或用户目录名称编辑群组:

这种方式下,群组名称可以编辑。

名称 类型 是否必须 默认值 备注 其他信息
id string 必须 群组ID
userDirectoryId string 与userDirectoryName二选一 所属用户目录ID,ID和名称只需传一个即可,都传时以ID为准
userDirectoryName string 与userDirectoryId二选一 所属用户目录名称,ID和名称只需传一个即可,都传时以ID为准
name string 非必须 群组名
description string 非必须 描述
userIdEditWay string 非必须 'set' 用户编辑方式,'set'重置,'append'追加,'delete'删除
userIdList string[] 非必须 用户ID列表 ID列表和名称列表传一个即可,如果都传,以ID列表为准
userNameList string[] 非必须 用户名列表 ID列表和名称列表传一个即可,如果都传,以ID列表为准
resourceGroupIdEditWay string 非必须 'set' 应用分类编辑方式,'set'重置,'append'追加,'delete'删除
resourceGroupIdList string[] 非必须 应用分类ID列表 ID列表和名称列表传一个即可,如果都传,以ID列表为准
resourceGroupNameList string[] 非必须 应用分类名列表 ID列表和名称列表传一个即可,如果都传,以ID列表为准
resourceIdEditWay string 非必须 'set' 应用编辑方式,'set'重置,'append'追加,'delete'删除
resourceIdList string[] 非必须 应用ID列表 ID列表和名称列表传一个即可,如果都传,以ID列表为准
resourceNameList string[] 非必须 应用名列表 ID列表和名称列表传一个即可,如果都传,以ID列表为准

根据群组ID、用户目录ID或用户目录名称编辑群组:

名称 类型 是否必须 默认值 备注 其他信息
name string 必须 群组名
userDirectoryId string 与userDirectoryName二选一 所属用户目录ID,ID和名称只需传一个即可,都传时以ID为准
userDirectoryName string 与userDirectoryId二选一 所属用户目录ID,ID和名称只需传一个即可,都传时以ID为准
description string 非必须 描述
userIdEditWay string 非必须 'set' 用户编辑方式,'set'重置,'append'追加,'delete'删除
userIdList string[] 非必须 用户ID列表 ID列表和名称列表传一个即可,如果都传,以ID列表为准
userNameList string[] 非必须 用户名列表 ID列表和名称列表传一个即可,如果都传,以ID列表为准
resourceGroupIdEditWay string 非必须 'set' 应用分类编辑方式,'set'重置,'append'追加,'delete'删除
resourceGroupIdList string[] 非必须 应用分类ID列表 ID列表和名称列表传一个即可,如果都传,以ID列表为准
resourceGroupNameList string[] 非必须 应用分类名列表 ID列表和名称列表传一个即可,如果都传,以ID列表为准
resourceIdEditWay string 非必须 'set' 应用编辑方式,'set'重置,'append'追加,'delete'删除
resourceIdList string[] 非必须 应用ID列表 ID列表和名称列表传一个即可,如果都传,以ID列表为准
resourceNameList string[] 非必须 应用名列表 ID列表和名称列表传一个即可,如果都传,以ID列表为准

请求示例

{
    "userIdEditWay": "set",
    "resourceIdEditWay": "set",
    "resourceGroupIdEditWay": "set",
    "id": "5687d130-eea8-11eb-9b6a-9f8657632b78",
    "userDirectoryId": "5687d130-eea8-11eb-9b6a-9f8657632b70",
    "name": "外部用户群组1",
    "description": "",
    "userIdList": [
        "30fe65e0-ee13-11eb-8358-05ceb6b852d6"
    ],
    "resourceGroupIdList": [],
    "resourceIdList": [
        "4204aa90-edf3-11eb-8358-05ceb6b852d6"
    ]
}

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 必须 错误码,非0表示错误,具体含义请参考错误码定义
data object 必须 返回内容
msg string 必须 描述信息  

返回示例

{
    "code": 0,
    "data": {},
    "msg": "请求成功",
    "traceId": "0321d1efe3801000"
}

错误信息

错误提示 错误码
参数检查出错 10000001
用户目录不存在 77200001
群组不存在或已被删除 10000000
外部导入群组不允许编辑 77200004
群组名称(%s)已存在 77200005
用户目录不允许被编辑 77200004
服务器内部错误 10000000
ExternalUser不存在 77200004
Resource不存在 77200004
ResourceGroup不存在 77200004
深信服科技 all right reserved,powered by Gitbook本文档更新于: 2024-05-18 14:38

results matching ""

    No results matching ""